-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README and documentation #2047
Conversation
87ba165
to
fe159a8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for setting up this static website. I initially considered using Docusaurus, but managing the documentation with MkDocs seems easier.
/assign @yuchaoran2011 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for updating this Spark Operator docs @ChenYi015! This is great!
I think, we discussed before that we are planning to migrate Spark Operator docs to the Kubeflow website: #1928.
Similar to other Kubeflow components (Model Registry, Pipelines, Training Operator, etc.)
So users can get information about the components from the single place: https://www.kubeflow.org/docs/components/
Also, Kubeflow docs leads can help you with docs review, etc.
/cc @StefanoFioravanzo @hbelmiro @kubeflow/release-team
@andreyvelich there is a small precedent for having an external website for some docs, namely the KFP SDK. The main reason to consider using a separate site would be if there are going to be lots of different versions with significant changes between them (as we don't really have the ability to version each component separately on the Kubeflow website). But obviously, we should try and make it work on the Kubeflow website, if possible. |
@andreyvelich What is the process for migrating documentation to the Kubeflow docs? Which repository should we raise a PR in? Do we have control over approving future documentation changes? Since @ChenYi015 has done most of the work, it would be helpful to provide him with pointers so he can convert this into a Kubeflow Docs PR. |
@vara-bonthu you can make a PR on the website repo https://github.com/kubeflow/website It's pretty much the same as MkDocs (uses markdown) but uses Hugo with the Docsy theme. It should be very straightforward to just copy what has been proposed here into a new section under "components". |
@thesuperzapper Yes, I am aware of these docs. This is mostly done because KFP is using automation to generate SDK docs from their SDK client: https://github.com/kubeflow/pipelines/tree/master/docs. It is hard to auto generate SDK docs in
Yes, this is valid point that components might need to be versioned separately from the website version. We discussed before with @StefanoFioravanzo that ideally docs for the components should live in their repo, and we should configure our Hugo website to render them. But we haven't got a chance to discuss how we can do it. The main goal is to make sure our users can easily navigate in Kubeflow ecosystem to get desired value.
You should raise a PR under |
@ChenYi015 Are you looking to raise a PR to this repo https://github.com/kubeflow/website/tree/master/content/en/docs/components? Let me know if you need a help so that I can move the docs to the new repo. |
@vara-bonthu Sorry for the late response, I have raised a PR #3767 to move docs to kubeflow website . |
@ChenYi015 is this PR still needed since you opened a new PR to the website repo? |
@ChenYi015 already opened this PR: kubeflow/website#3767 |
@andreyvelich |
That sounds good. |
That's a good point. We can do that once the docs are published under Kubeflow docs. Let's wait until this PR#3767 is merged |
Signed-off-by: Yi Chen <[email protected]>
@vara-bonthu I have redirected links in README to the kubeflow spark operator docs. |
Thank you @ChenYi015! |
@andreyvelich I had removed the docs except for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this huge effort @ChenYi015!
/lgtm
/assign @vara-bonthu @yuchaoran2011
/hold For @vara-bonthu and @yuchaoran2011 review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vara-bonthu The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
@vara-bonthu @ChenYi015 Do we want to add the community meeting notes to the readme as I mentioned here: #2047 (comment) ? |
Signed-off-by: Yi Chen <[email protected]>
@andreyvelich I had added a link to the community call in the README. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this @ChenYi015!
/hold cancel
/lgtm
* Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: Yaniv Kunda <[email protected]>
* Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]>
* Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]>
* Update README and documentation (#2047) * Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Add PodDisruptionBudget to chart (#2078) * Add PodDisruptionBudget to chart Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> * PR comments Signed-off-by: Carlos Sánchez Páez <[email protected]> --------- Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Set topologySpreadConstraints Signed-off-by: jbhalodia-slack <[email protected]> * Update README and increase patch version Signed-off-by: jbhalodia-slack <[email protected]> * Revert replicaCount change Signed-off-by: jbhalodia-slack <[email protected]> * Update README after master merger Signed-off-by: jbhalodia-slack <[email protected]> * Update README Signed-off-by: jbhalodia-slack <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Co-authored-by: Yi Chen <[email protected]> Co-authored-by: Carlos Sánchez Páez <[email protected]>
* Update README and documentation (kubeflow#2047) * Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Add PodDisruptionBudget to chart (kubeflow#2078) * Add PodDisruptionBudget to chart Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> * PR comments Signed-off-by: Carlos Sánchez Páez <[email protected]> --------- Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Set topologySpreadConstraints Signed-off-by: jbhalodia-slack <[email protected]> * Update README and increase patch version Signed-off-by: jbhalodia-slack <[email protected]> * Revert replicaCount change Signed-off-by: jbhalodia-slack <[email protected]> * Update README after master merger Signed-off-by: jbhalodia-slack <[email protected]> * Update README Signed-off-by: jbhalodia-slack <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Co-authored-by: Yi Chen <[email protected]> Co-authored-by: Carlos Sánchez Páez <[email protected]> (cherry picked from commit 4108f54)
* Update helm docs (#2081) Signed-off-by: Carlos Sánchez Páez <[email protected]> (cherry picked from commit eca3fc8) * Update the process to build api-docs, generate CRD manifests and code (#2046) * Update .gitignore Signed-off-by: Yi Chen <[email protected]> * Update .dockerignore Signed-off-by: Yi Chen <[email protected]> * Update Makefile Signed-off-by: Yi Chen <[email protected]> * Update the process to generate api docs Signed-off-by: Yi Chen <[email protected]> * Update the workflow to generate api docs Signed-off-by: Yi Chen <[email protected]> * Use controller-gen to generate CRD and deep copy related methods Signed-off-by: Yi Chen <[email protected]> * Update helm chart CRDs Signed-off-by: Yi Chen <[email protected]> * Update workflow for building spark operator Signed-off-by: Yi Chen <[email protected]> * Update README.md Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> (cherry picked from commit 779ea3d) * Add topologySpreadConstraints (#2091) * Update README and documentation (#2047) * Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Add PodDisruptionBudget to chart (#2078) * Add PodDisruptionBudget to chart Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> * PR comments Signed-off-by: Carlos Sánchez Páez <[email protected]> --------- Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Set topologySpreadConstraints Signed-off-by: jbhalodia-slack <[email protected]> * Update README and increase patch version Signed-off-by: jbhalodia-slack <[email protected]> * Revert replicaCount change Signed-off-by: jbhalodia-slack <[email protected]> * Update README after master merger Signed-off-by: jbhalodia-slack <[email protected]> * Update README Signed-off-by: jbhalodia-slack <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Co-authored-by: Yi Chen <[email protected]> Co-authored-by: Carlos Sánchez Páez <[email protected]> (cherry picked from commit 4108f54) * Use controller-runtime to reconsturct spark operator (#2072) * Use controller-runtime to reconstruct spark operator Signed-off-by: Yi Chen <[email protected]> * Update helm charts Signed-off-by: Yi Chen <[email protected]> * Update examples Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> (cherry picked from commit 0dc641b) --------- Co-authored-by: Carlos Sánchez Páez <[email protected]> Co-authored-by: jbhalodia-slack <[email protected]>
* Update README and documentation (kubeflow#2047) * Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Add PodDisruptionBudget to chart (kubeflow#2078) * Add PodDisruptionBudget to chart Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> * PR comments Signed-off-by: Carlos Sánchez Páez <[email protected]> --------- Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Set topologySpreadConstraints Signed-off-by: jbhalodia-slack <[email protected]> * Update README and increase patch version Signed-off-by: jbhalodia-slack <[email protected]> * Revert replicaCount change Signed-off-by: jbhalodia-slack <[email protected]> * Update README after master merger Signed-off-by: jbhalodia-slack <[email protected]> * Update README Signed-off-by: jbhalodia-slack <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Co-authored-by: Yi Chen <[email protected]> Co-authored-by: Carlos Sánchez Páez <[email protected]>
* Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]>
* Update README and documentation (kubeflow#2047) * Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Add PodDisruptionBudget to chart (kubeflow#2078) * Add PodDisruptionBudget to chart Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> * PR comments Signed-off-by: Carlos Sánchez Páez <[email protected]> --------- Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Set topologySpreadConstraints Signed-off-by: jbhalodia-slack <[email protected]> * Update README and increase patch version Signed-off-by: jbhalodia-slack <[email protected]> * Revert replicaCount change Signed-off-by: jbhalodia-slack <[email protected]> * Update README after master merger Signed-off-by: jbhalodia-slack <[email protected]> * Update README Signed-off-by: jbhalodia-slack <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Co-authored-by: Yi Chen <[email protected]> Co-authored-by: Carlos Sánchez Páez <[email protected]>
* Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]>
…ubeflow#2108) * Update helm docs (kubeflow#2081) Signed-off-by: Carlos Sánchez Páez <[email protected]> (cherry picked from commit eca3fc8) * Update the process to build api-docs, generate CRD manifests and code (kubeflow#2046) * Update .gitignore Signed-off-by: Yi Chen <[email protected]> * Update .dockerignore Signed-off-by: Yi Chen <[email protected]> * Update Makefile Signed-off-by: Yi Chen <[email protected]> * Update the process to generate api docs Signed-off-by: Yi Chen <[email protected]> * Update the workflow to generate api docs Signed-off-by: Yi Chen <[email protected]> * Use controller-gen to generate CRD and deep copy related methods Signed-off-by: Yi Chen <[email protected]> * Update helm chart CRDs Signed-off-by: Yi Chen <[email protected]> * Update workflow for building spark operator Signed-off-by: Yi Chen <[email protected]> * Update README.md Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> (cherry picked from commit 779ea3d) * Add topologySpreadConstraints (kubeflow#2091) * Update README and documentation (kubeflow#2047) * Update docs Signed-off-by: Yi Chen <[email protected]> * Remove docs and update README Signed-off-by: Yi Chen <[email protected]> * Add link to monthly community meeting Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Add PodDisruptionBudget to chart (kubeflow#2078) * Add PodDisruptionBudget to chart Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> * PR comments Signed-off-by: Carlos Sánchez Páez <[email protected]> --------- Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> * Set topologySpreadConstraints Signed-off-by: jbhalodia-slack <[email protected]> * Update README and increase patch version Signed-off-by: jbhalodia-slack <[email protected]> * Revert replicaCount change Signed-off-by: jbhalodia-slack <[email protected]> * Update README after master merger Signed-off-by: jbhalodia-slack <[email protected]> * Update README Signed-off-by: jbhalodia-slack <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> Signed-off-by: jbhalodia-slack <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Signed-off-by: Carlos Sánchez Páez <[email protected]> Co-authored-by: Yi Chen <[email protected]> Co-authored-by: Carlos Sánchez Páez <[email protected]> (cherry picked from commit 4108f54) * Use controller-runtime to reconsturct spark operator (kubeflow#2072) * Use controller-runtime to reconstruct spark operator Signed-off-by: Yi Chen <[email protected]> * Update helm charts Signed-off-by: Yi Chen <[email protected]> * Update examples Signed-off-by: Yi Chen <[email protected]> --------- Signed-off-by: Yi Chen <[email protected]> (cherry picked from commit 0dc641b) --------- Co-authored-by: Carlos Sánchez Páez <[email protected]> Co-authored-by: jbhalodia-slack <[email protected]>
🛑 Important:
Please open an issue to discuss significant work before you start. We appreciate your contributions and don't want your efforts to go to waste!
For guidelines on how to contribute, please review the CONTRIBUTING.md document.
Purpose of this PR
Provide a clear and concise description of the changes. Explain the motivation behind these changes and link to relevant issues or discussions.
Proposed changes:
Use mkdocs-material to generate static websiteAdd a new github action workflow for mkdocs to deploy website to github pagesdocs/*.md
and keep only thedocs/api-docs.md
file.README.md
to the kubeflow websitedocs/who-is-using.md
toADOPTERS.md
and sort the names in alphabetical orderChange Category
Indicate the type of change by marking the applicable boxes:
Rationale
Checklist
Before submitting your PR, please review the following:
Additional Notes